/* eslint-disable @typescript-eslint/no-explicit-any */
/*
 *  Copyright 2021 Collate
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  http://www.apache.org/licenses/LICENSE-2.0
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

 /**
 * Represents a CSV file.
 */
export interface CSVFile {
    headers?: CSVHeader[];
    records?: Array<string[]>;
}

/**
 * Represents a header for a field in a CSV file.
 */
export interface CSVHeader {
    /**
     * Description of the header field for documentation purposes.
     */
    description: string;
    /**
     * Example values for the field
     */
    examples:  string[];
    name:      string;
    required?: boolean;
}
